<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Low Power Callback</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__smif__functions__syspm__callback.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Low Power Callback<div class="ingroups"><a class="el" href="group__group__smif.html">SMIF         (Serial Memory Interface)</a> &raquo; <a class="el" href="group__group__smif__functions.html">Functions</a><a class="el" href="group__group__smif.html">SMIF         (Serial Memory Interface)</a> &raquo; <a class="el" href="group__group__smif__functions.html">Functions</a> &raquo;  &#124; <a class="el" href="group__group__smif__low__level__functions.html">Low Level Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The driver supports SysPm callback for Deep Sleep and Hibernate transition. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga89e417482a719f6fd6b4d4ff11f6e1f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__smif__functions__syspm__callback.html#ga89e417482a719f6fd6b4d4ff11f6e1f6">Cy_SMIF_DeepSleepCallback</a> (<a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *callbackParams, <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga89e417482a719f6fd6b4d4ff11f6e1f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function handles the transition of the SMIF into and out of Deep Sleep mode.  <a href="#ga89e417482a719f6fd6b4d4ff11f6e1f6">More...</a><br /></td></tr>
<tr class="separator:ga89e417482a719f6fd6b4d4ff11f6e1f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30a41308d83905b3feb36f67a80d9f71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__smif__functions__syspm__callback.html#ga30a41308d83905b3feb36f67a80d9f71">Cy_SMIF_HibernateCallback</a> (<a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *callbackParams, <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga30a41308d83905b3feb36f67a80d9f71"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function handles the transition of the SMIF into Hibernate mode.  <a href="#ga30a41308d83905b3feb36f67a80d9f71">More...</a><br /></td></tr>
<tr class="separator:ga30a41308d83905b3feb36f67a80d9f71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga89e417482a719f6fd6b4d4ff11f6e1f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89e417482a719f6fd6b4d4ff11f6e1f6">&#9670;&nbsp;</a></span>Cy_SMIF_DeepSleepCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SMIF_DeepSleepCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *&#160;</td>
          <td class="paramname"><em>callbackParams</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function handles the transition of the SMIF into and out of Deep Sleep mode. </p>
<p>It prevents the device from entering DeepSleep if SMIF is actively communicating, or there is any data in the TX or RX FIFOs, or SMIF is in memory mode.</p>
<p>This function should be called while execution of <a class="el" href="group__group__syspm__functions__power.html#ga5150c28fe4d2626720c1fbf74b3111ca">Cy_SysPm_CpuEnterDeepSleep</a> therefore must be registered as a callback before the call. To register it call <a class="el" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a> and specify <a class="el" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0abc51d74deff0ceea4304b01b2d57bd9d">CY_SYSPM_DEEPSLEEP</a> as the callback type.</p>
<dl class="section note"><dt>Note</dt><dd>This API is template and user should add code for external memory enter/exit low power mode.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">callbackParams</td><td>The pointer to the structure with SMIF SysPm callback parameters (pointer to SMIF registers, context and call mode <a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a>).</td></tr>
    <tr><td class="paramname">mode</td><td>Callback mode, see <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a></dd></dl>
<p>Example setup of SysPM deep sleep and hibernate mode </p><div class="fragment"><div class="line">    <span class="comment">/* Initialize callback parameters with SMIF register base address and</span></div><div class="line"><span class="comment">     * context structure */</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> smifSysPm =</div><div class="line">    {</div><div class="line">        <span class="comment">/* .base */</span> SMIF0,</div><div class="line">        <span class="comment">/* .context */</span> &amp;smifContext</div><div class="line">    };</div><div class="line"></div><div class="line">    <span class="comment">/* Register SMIF SysPm callback for deep sleep mode*/</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__t.html">cy_stc_syspm_callback_t</a> smifDeepSleepCb =</div><div class="line">    {</div><div class="line">        <span class="comment">/* .callback       */</span> &amp;<a class="code" href="group__group__smif__functions__syspm__callback.html#ga89e417482a719f6fd6b4d4ff11f6e1f6">Cy_SMIF_DeepSleepCallback</a>,</div><div class="line">        <span class="comment">/* .type           */</span> <a class="code" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0abc51d74deff0ceea4304b01b2d57bd9d">CY_SYSPM_DEEPSLEEP</a>,</div><div class="line">        <span class="comment">/* .skipMode       */</span> 0U,</div><div class="line">        <span class="comment">/* .callbackParams */</span> &amp;smifSysPm,</div><div class="line">        <span class="comment">/* .prevItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .nextItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .order          */</span> 0</div><div class="line">    };</div><div class="line">    <a class="code" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a>(&amp;smifDeepSleepCb);</div><div class="line"></div><div class="line">    <span class="comment">/* Register SMIF SysPm callback for hibernate mode*/</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__t.html">cy_stc_syspm_callback_t</a> smifHibernateCb=</div><div class="line">    {</div><div class="line">        <span class="comment">/* .callback       */</span> &amp;<a class="code" href="group__group__smif__functions__syspm__callback.html#ga30a41308d83905b3feb36f67a80d9f71">Cy_SMIF_HibernateCallback</a>,</div><div class="line">        <span class="comment">/* .type           */</span> <a class="code" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0a613e2f83e3ab88e3569cf34ff0fa5912">CY_SYSPM_HIBERNATE</a>,</div><div class="line">        <span class="comment">/* .skipMode       */</span> 0U,</div><div class="line">        <span class="comment">/* .callbackParams */</span> &amp;smifSysPm,</div><div class="line">        <span class="comment">/* .prevItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .nextItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .order          */</span> 0</div><div class="line">    };</div><div class="line">    <a class="code" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a>(&amp;smifHibernateCb);</div><div class="line"></div></div><!-- fragment -->
</div>
</div>
<a id="ga30a41308d83905b3feb36f67a80d9f71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30a41308d83905b3feb36f67a80d9f71">&#9670;&nbsp;</a></span>Cy_SMIF_HibernateCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SMIF_HibernateCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *&#160;</td>
          <td class="paramname"><em>callbackParams</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function handles the transition of the SMIF into Hibernate mode. </p>
<p>It prevents the device from entering Hibernate if the SMIF is actively communicating, or there is any data in the TX or RX FIFO, or SMIF is in memory mode.</p>
<p>This function should be called during execution of <a class="el" href="group__group__syspm__functions__power.html#gae97647a28c370674ba57d451d21d1c51">Cy_SysPm_SystemEnterHibernate</a> therefore it must be registered as a callback before the call. To register it call <a class="el" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a> and specify <a class="el" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0a613e2f83e3ab88e3569cf34ff0fa5912">CY_SYSPM_HIBERNATE</a> as the callback type.</p>
<dl class="section note"><dt>Note</dt><dd>This API is template and user should add code for external memory enter/exit low power mode.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">callbackParams</td><td>The pointer to the structure with SMIF SysPm callback parameters (pointer to SMIF registers, context and call mode <a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a>).</td></tr>
    <tr><td class="paramname">mode</td><td>Callback mode, see <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a></dd></dl>
<p>Example setup of SysPM deep sleep and hibernate mode </p><div class="fragment"><div class="line">    <span class="comment">/* Initialize callback parameters with SMIF register base address and</span></div><div class="line"><span class="comment">     * context structure */</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> smifSysPm =</div><div class="line">    {</div><div class="line">        <span class="comment">/* .base */</span> SMIF0,</div><div class="line">        <span class="comment">/* .context */</span> &amp;smifContext</div><div class="line">    };</div><div class="line"></div><div class="line">    <span class="comment">/* Register SMIF SysPm callback for deep sleep mode*/</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__t.html">cy_stc_syspm_callback_t</a> smifDeepSleepCb =</div><div class="line">    {</div><div class="line">        <span class="comment">/* .callback       */</span> &amp;<a class="code" href="group__group__smif__functions__syspm__callback.html#ga89e417482a719f6fd6b4d4ff11f6e1f6">Cy_SMIF_DeepSleepCallback</a>,</div><div class="line">        <span class="comment">/* .type           */</span> <a class="code" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0abc51d74deff0ceea4304b01b2d57bd9d">CY_SYSPM_DEEPSLEEP</a>,</div><div class="line">        <span class="comment">/* .skipMode       */</span> 0U,</div><div class="line">        <span class="comment">/* .callbackParams */</span> &amp;smifSysPm,</div><div class="line">        <span class="comment">/* .prevItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .nextItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .order          */</span> 0</div><div class="line">    };</div><div class="line">    <a class="code" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a>(&amp;smifDeepSleepCb);</div><div class="line"></div><div class="line">    <span class="comment">/* Register SMIF SysPm callback for hibernate mode*/</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__t.html">cy_stc_syspm_callback_t</a> smifHibernateCb=</div><div class="line">    {</div><div class="line">        <span class="comment">/* .callback       */</span> &amp;<a class="code" href="group__group__smif__functions__syspm__callback.html#ga30a41308d83905b3feb36f67a80d9f71">Cy_SMIF_HibernateCallback</a>,</div><div class="line">        <span class="comment">/* .type           */</span> <a class="code" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0a613e2f83e3ab88e3569cf34ff0fa5912">CY_SYSPM_HIBERNATE</a>,</div><div class="line">        <span class="comment">/* .skipMode       */</span> 0U,</div><div class="line">        <span class="comment">/* .callbackParams */</span> &amp;smifSysPm,</div><div class="line">        <span class="comment">/* .prevItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .nextItm        */</span> NULL,</div><div class="line">        <span class="comment">/* .order          */</span> 0</div><div class="line">    };</div><div class="line">    <a class="code" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a>(&amp;smifHibernateCb);</div><div class="line"></div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
